home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 25 / AACD 25.iso / AACD / Utilities / BasiliskII / README < prev    next >
Encoding:
Text File  |  2001-05-31  |  30.9 KB  |  745 lines
  1.  
  2.   Basilisk II
  3.   A 68k Macintosh emulator
  4.  
  5.   Copyright (C) 1997-2001 Christian Bauer et al.
  6.  
  7.  
  8. License
  9. -------
  10.  
  11. Basilisk II is available under the terms of the GNU General Public License.
  12. See the file "COPYING" that is included in the distribution for details.
  13.  
  14.  
  15. Overview
  16. --------
  17.  
  18. Basilisk II is an Open Source 68k Macintosh emulator. That is, it enables
  19. you to run 68k MacOS software on you computer, even if you are using a
  20. different operating system. However, you still need a copy of MacOS and
  21. a Macintosh ROM image to use Basilisk II.
  22.  
  23. Basilisk II has currently been ported to the following systems:
  24.   - BeOS R4 (PowerPC and x86)
  25.   - Unix (tested under Linux, Solaris 2.5, FreeBSD 3.x, NetBSD 1.4.2 and
  26.     IRIX 6.5)
  27.   - AmigaOS 3.x
  28.   - Windows NT 4.0 (mostly works under Windows 95/98, too)
  29.  
  30. Some features of Basilisk II:
  31.   - Emulates either a Mac Classic (which runs MacOS 0.x thru 7.5)
  32.     or a Mac II series machine (which runs MacOS 7.x, 8.0 and 8.1),
  33.     depending on the ROM being used
  34.   - Color video display
  35.   - CD quality sound output
  36.   - Floppy disk driver (only 1.44MB disks supported)
  37.   - Driver for HFS partitions and hardfiles
  38.   - CD-ROM driver with basic audio functions
  39.   - Easy file exchange with the host OS via a "Host Directory Tree" icon
  40.     on the Mac desktop
  41.   - Ethernet driver
  42.   - Serial drivers
  43.   - SCSI Manager (old-style) emulation
  44.   - Emulates extended ADB keyboard and 3-button mouse
  45.   - Uses UAE 68k emulation or (under AmigaOS and NetBSD/m68k) real 68k
  46.     processor
  47.  
  48. The emulator is not yet complete. See the file "TODO" for a list of
  49. unimplemented stuff.
  50.  
  51.  
  52. Requirements and Installation
  53. -----------------------------
  54.  
  55. Please consult the file "INSTALL" for a list of system requirements and
  56. installation instructions.
  57.  
  58.  
  59. Configuration
  60. -------------
  61.  
  62. Basilisk II is configured via the preferences editor that appears on startup.
  63. If you have a version without preferences editor (e.g. because of missing GTK+
  64. under Unix), you have to edit the preferences file manually.
  65.  
  66. The settings are stored in a text file:
  67.  
  68. BeOS:
  69.   /boot/home/config/settings/BasiliskII_prefs
  70.  
  71. Unix:
  72.   ~/.basilisk_ii_prefs
  73.  
  74. AmigaOS:
  75.   ENV:BasiliskII_prefs
  76.  
  77. Windows:
  78.   BasiliskII_prefs (in the same directory as the executable)
  79.  
  80. If no preferences file is present, Basilisk II will create one with the
  81. default settings upon startup.
  82.  
  83.  
  84. Preferences File Format
  85. -----------------------
  86.  
  87. The preferences file is a text file editable with any text editor.
  88. Each line in this file has the format "keyword value" and describes
  89. one preferences item. For each keyword, the meaning of the "value"
  90. string may vary across platforms. The following keywords exist:
  91.  
  92. disk <volume description>
  93.  
  94.   This item describes one MacOS volume to be mounted by Basilisk II.
  95.   There can be multiple "disk" lines in the preferences file. Basilisk II
  96.   can handle hardfiles (byte-per-byte images of HFS volumes in a file on
  97.   the host system) as well as HFS partitions on hard disks etc. (but Basilisk
  98.   II doesn't know about MacOS partition tables; it relies on the host OS to
  99.   handle this). The "volume description" is either the pathname of a hardfile
  100.   or a platform-dependant description of an HFS partition or drive. If the
  101.   volume description starts with an asterisk ("*"), the volume is write
  102.   protected for MacOS (and the "*" is discarded).
  103.  
  104.   BeOS:
  105.     To specify an HFS partition, simply specify its path (e.g.
  106.     "/dev/disk/scsi/0/1/0/0_3"). If you don't specify any volume, Basilisk II
  107.     will search for and use all available HFS partitions.
  108.  
  109.   Unix:
  110.     To specify an HFS partition, simply specify its path (e.g.
  111.     "/dev/sda5").
  112.  
  113.   AmigaOS:
  114.     Partitions/drives are specified in the following format:
  115.       /dev/<device name>/<unit>/<open flags>/<start block>/<size>/<block size>
  116.     "start block" and "size" are given in blocks, "block size" is given in
  117.     bytes.
  118.  
  119.   Windows:
  120.     To define a logical volume (Windows NT only), specify its path (e.g. "c:\").
  121.     To define a physical volume (NT and 9x), additionally give the "physical"
  122.     keyword (E.g. "physical c:\"). For safety reasons, volumes are mounted as
  123.     read-only. This is due to the bugs in PC Exchange. If you don't specify
  124.     any volume, the files *.hfv and *.dsk are searched from the current
  125.     directory. Note that in this case, Basilisk II tries to boot from the first
  126.     volume file found, which is random and may not be what you want.
  127.  
  128. floppy <floppy drive description>
  129.  
  130.   This item describes one floppy drive to be used by Basilisk II. There
  131.   can be multiple "floppy" lines in the preferences file. If no "floppy"
  132.   line is given, Basilisk II will try to automatically detect and use
  133.   installed floppy drives. The format of the "floppy drive description"
  134.   is the same as that of "disk" lines.
  135.  
  136. cdrom <CD-ROM drive description>
  137.  
  138.   This item describes one CD-ROM drive to be used by Basilisk II. There
  139.   can be multiple "cdrom" lines in the preferences file. If no "cdrom"
  140.   line is given, Basilisk II will try to automatically detect and use
  141.   installed CD-ROM drives. The format of the "CD-ROM drive description"
  142.   is the same as that of "disk" lines.
  143.  
  144. extfs <direcory path>
  145.  
  146.   This item specifies the root directory for the "Host Directory Tree"
  147.   file system (the "Unix/BeOS/Amiga/..." icon on the Finder desktop).
  148.   All objects contained in that directory are accessible by Mac applications.
  149.   This feature is only available when File System Manager V1.2 or later
  150.   is installed on the Mac side. FSM 1.2 is built-in beginning with MacOS 7.6
  151.   and can be installed as a system extension (downloadable from Apple, look
  152.   for the FSM SDK in the developer section) for earlier MacOS versions.
  153.  
  154. scsi0 <SCSI target> ... scsi6 <SCSI target>
  155.  
  156.   These items describe the SCSI target to be used for a given Mac SCSI
  157.   ID by Basilisk II. Basilisk II emulates the old SCSI Manager and allows
  158.   to assign a different SCSI target (they don't even have to be on the
  159.   same SCSI bus) for each SCSI ID (0..6) as seen by the MacOS. "scsi0"
  160.   describes the target for ID 0, "scsi1" the target for ID 1 etc.
  161.   The format of the "SCSI target" is platform specific.
  162.  
  163.   BeOS:
  164.     The "SCSI target" has the format "<bus>/<unit>" (e.g. "0/2").
  165.     Due to a bug in BeOS, using SCSI with Basilisk II may cause the
  166.     SCSI bus to hang. Use with caution.
  167.  
  168.   Linux:
  169.     The "SCSI target" has to be the name of a device that complies to
  170.     the Generic SCSI driver API. On a standard Linux installation, these
  171.     devices are "/dev/sg0", "/dev/sg1" etc. Note that you must have
  172.     appropriate access rights to these devices and that Generic SCSI
  173.     support has to be compiled into the kernel.
  174.  
  175.   FreeBSD:
  176.     The "SCSI target" has the format "<id>/<lun>" (e.g. "2/0").
  177.  
  178.   AmigaOS:
  179.     The "SCSI target" has the format "<device name>/<unit>" (e.g.
  180.     "scsi.device/2").
  181.  
  182.   Windows:
  183.     The "SCSI target" has the format <"Vendor"> <"Model"> (e.g.
  184.     scsi0 "HP" "CD-Writer+ 7100"). Note the use of quotes.
  185.  
  186. screen <video mode>
  187.  
  188.   This item describes the type of video display to be used by Basilisk II.
  189.   If you are using a Mac Classic ROM, the display is always 1-bit 512x342
  190.   and this item is ignored. The format of the "video mode" is platform
  191.   specific.
  192.  
  193.   BeOS:
  194.     The "video mode" is one of the following:
  195.       win/<width>/<height>
  196.         8-bit color display in a window of the given size. This is the
  197.         default.
  198.       scr/<mode>
  199.         Full-screen display in BWindowScreen. <mode> is the bit number of
  200.         the video mode to use (see headers/be/interface/GraphicsDefs.h).
  201.         E.g. 0 = 640x480x8, 1 = 800x600x8 etc., 10 = 640x480x24,
  202.         11 = 800x600x24 etc., 18 = 640x480x15, 19 = 800x600x15 etc.
  203.         15 bit modes are preferable to 16 bit modes (which may show false
  204.         colors on PowerPC machines).
  205.     When you run in full-screen mode and switch to another Workspace,
  206.     Basilisk II is put in "suspend" mode (i.e. MacOS will be frozen).
  207.  
  208.   Unix:
  209.     The "video mode" is one of the following:
  210.       win/<width>/<height>
  211.         Color display in an X11 window of the given size. The color depth
  212.         (8/15/24 bit) depends on the depth of the underlying X11 screen.
  213.         This is the default.
  214.       dga/<width>/<height>
  215.         [if Basilisk II was configured with --enable-xf86-dga]
  216.         Full-screen display using the XFree86 DGA extension. The color depth
  217.         (8/15/24 bit) depends on the depth of the underlying X11 screen.
  218.         "width" and "height" specify the maximum width/height to use.
  219.         Saying "dga/0/0" means "complete screen".
  220.       dga/<frame buffer name>
  221.         [if Basilisk II was configured with --enable-fbdev-dga]
  222.         Full-screen display using the frame buffer device /dev/fb. The color
  223.         depth (8/15/24 bit) depends on the depth of the underlying X11 screen.
  224.         The "frame buffer name" is looked up in the "fbdevices" file (whose
  225.         path can be specified with the "fbdevicefile" prefs item) to determine
  226.         certain characteristics of the device (doing a "ls -l /dev/fb" should
  227.         tell you what your frame buffer name is).
  228.  
  229.   AmigaOS:
  230.     The "video mode" is one of the following:
  231.       win/<width>/<height>
  232.         Black-and-white display in a window of the given size on the
  233.         Workbench screen. This is the default and will also be used when
  234.         one of the other options (PIP/screen) fails to open.
  235.       pip/<width>/<height>
  236.         15-bit truecolor display in a Picasso96 PIP. This requires
  237.         Picasso96 as well as a PIP-capable graphics card (e.g. Picasso IV).
  238.       scr/<hexadecimal mode ID>
  239.         8/15/24-bit fullscreen display on a Picasso96/CyberGraphX screen with
  240.         the given mode ID. This requires Picasso96 or CyberGraphX. For 15 and
  241.         24 bit, the frame buffer format must be QuickDraw-compatible
  242.         (big-endian, xRGB 1:5:5:5 or xRGB 8:8:8:8). The screen size will be
  243.         the default size for that mode ID.
  244.  
  245.   Windows:
  246.     The "video mode" is one of the following:
  247.       win/<width>/<height>/<bits per pixel>
  248.         A refreshed screen mode that uses Windows GDI calls to write to the
  249.         screen. You may have other windows on top of Basilisk II.
  250.       dx/<width>/<height>/<bits per pixel>
  251.         A refreshed DirectX mode (minimum version 5.0). There are ways to
  252.         install DirectX 5 on NT 4. Some new display adapters work fine even
  253.         with DirectX 3.
  254.       fb/<width>/<height>/<bits per pixel>
  255.         A non-refreshed video mode that works only on NT. It accesses the
  256.         linear frame buffer directly (best performance of all three modes).
  257.         Use the hotkey Control-Shift-F12 to switch between Windows and Mac
  258.         displays. Fast task switch (Alt-Tab) and Explorer start menu
  259.         (Control-Esc) are disabled, Control-Alt-Del is enabled.
  260.     <width> and <height> can be either zeroes (uses current screen values),
  261.     or something else. "win" mode can use almost anything, for other modes
  262.     there must be a corresponding DirectX mode.
  263.     <bits> is ignored for mode "win" (uses current screen values).
  264.     If the mode is "win" and the dimensions are different than the desktop
  265.     dimensions, windowed mode is used. The window can be moved around by
  266.     dragging with the right mouse button. This mode remembers window positions
  267.     separately for different dimensions.
  268.     The supported values are 8,15,16,24,32. It is possible that some of them
  269.     do not work for you. In particular, it may be that only one of the
  270.     two modes, 15 and 16, is suitable for your card. You need to find out
  271.     the best solution by experimenting.
  272.     Basilisk II checks what display mode you are currently running and uses
  273.     that mode. The screen is always full screen. When you switch to another
  274.     application via Alt-Tab, Basilisk II is put in "snooze" mode (i.e. MacOS
  275.     is frozen).
  276.  
  277. seriala <serial port description>
  278.  
  279.   This item describes the serial port to be used as Port A (Modem Port)
  280.   by Basilisk II. If no "seriala" line is given, Basilisk II will try to
  281.   automatically detect and use installed serial ports. The "serial port
  282.   description" is a platform-dependant description of a serial port.
  283.  
  284.   BeOS:
  285.     Either specify the name of a serial port (e.g. "serial1") or one of
  286.     "parallel1", "parallel2" or "parallel3". See below for more information
  287.     about parallel ports.
  288.  
  289.   Unix:
  290.     Specify the device name of a serial port (e.g. "/dev/ttyS0") or a
  291.     parallel "lp" port (e.g. "/dev/lp1"; this only works under Linux and
  292.     FreeBSD). See below for more information about parallel ports.
  293.  
  294.   AmigaOS:
  295.     You have to specify the name of the serial device and the device unit
  296.     as "<device name>/<unit>" (e.g. "serial.device/0"). If the given device
  297.     is not compatible to serial.device, Basilisk II will crash. If the
  298.     device name starts with an asterisk (e.g. "*parallel.device/0"), the
  299.     device is treated as a parallel.device compatible device. See below for
  300.     more information about parallel ports.
  301.  
  302.   Windows:
  303.     Specify "COM1" or "COM2" for com port 1 or 2, respectively.
  304.  
  305.   Parallel ports: If you select a parallel port it will look like a serial
  306.   port to MacOS but Basilisk II will only allow data output and ignore baud
  307.   rate settings etc. You should be able to get some printers to work with
  308.   this method (provided that you have the right printer driver, like
  309.   "Power Print" (see www.gdt.com)).
  310.  
  311. serialb <serial port description>
  312.  
  313.   This item describes the serial port to be used as Port B (Printer Port)
  314.   by Basilisk II. If no "serialb" line is given, Basilisk II will try to
  315.   automatically detect and use installed serial ports. The format of the
  316.   "serial port description" is the same as that of the "seriala" option.
  317.  
  318. ether <ethernet card description>
  319.  
  320.   This item describes the Ethernet card to be used for Ethernet networking
  321.   by Basilisk II. If no "ether" line is given, Ethernet networking is disabled
  322.   (although the Ethernet driver of Basilisk II will behave like a "dummy"
  323.   Ethernet card in this case). If you are using a Mac Classic ROM, Ethernet
  324.   is not available and this setting is ignored. The "ethernet card description"
  325.   is a platform-dependant description of an ethernet card.
  326.  
  327.   BeOS:
  328.     It doesn't matter what you give as "ethernet card description", Basilisk II
  329.     will always use the first Ethernet card it finds as long an an "ether"
  330.     line exists (e.g. say "ether yes"). Using Ethernet requires the "sheep_net"
  331.     Net Server add-on to be installed. The first time you start Basilisk II
  332.     with Ethernet enabled you will be asked whether it's OK to make the
  333.     necessary changes to your BeOS network configuration to enable sheep_net.
  334.  
  335.   Linux:
  336.     The "ethernet card description" is the name of an Ethernet interface.
  337.     There are two approaches to networking with Basilisk II:
  338.  
  339.       1. Direct access to an Ethernet card via the "sheep_net" driver.
  340.          In this case, the "ethernet card description" must be the name
  341.          of a real Ethernet card, e.g. "eth0". It also requires the "sheep_net"
  342.          driver to be installed and accessible. This approach will allow you
  343.          to run all networking protocols under MacOS (TCP/IP, AppleTalk, IPX
  344.          etc.) but there is no connection between Linux networking and MacOS
  345.          networking. MacOS will only be able to talk to other machines on
  346.          the Ethernet, but not to other networks that your Linux box routes
  347.          (e.g. a second Ethernet or a PPP connection to the Internet).
  348.  
  349.       2. Putting Basilisk II on a virtual Ethernet via the "ethertap" device.
  350.          In this case, the "ethernet card description" must be the name
  351.          of an ethertap interface, e.g. "tap0". It also requires that you
  352.          configure your kernel to enable routing and the ethertap device:
  353.          under "Networking options", enable "Kernel/User netlink socket" and
  354.          "Netlink device emulation", under "Network device support", activate
  355.          "Ethertap network tap". You also have to modify drivers/net/ethertap.c
  356.          a bit before compiling the new kernel:
  357.  
  358.           - insert "#define CONFIG_ETHERTAP_MC 1" near the top (after the
  359.             #include lines)
  360.           - comment out the line "dev->flags|=IFF_NOARP;" in ethertap_probe()
  361.  
  362.          Next, see /usr/src/linux/Documentation/networking/ethertap.txt for
  363.          information on how to set up /dev/tap* device nodes and activate the
  364.          ethertap interface. Under MacOS, select an IP address that is on the
  365.          virtual network and set the default gateway to the IP address of the
  366.          ethertap interface. This approach will let you access all networks
  367.          that your Linux box has access to (especially, if your Linux box has
  368.          a dial-up Internet connection and is configured for IP masquerading,
  369.          you can access the Internet from MacOS). The drawback is that you
  370.          can only use network protocols that Linux can route, so you have to
  371.          install and configure netatalk if you want to use AppleTalk. Here is
  372.          an example /etc/atalk/atalkd.conf for a LAN:
  373.  
  374.            eth0 -seed -phase 2 -net 1 -addr 1.47 -zone "Ethernet"
  375.            tap0 -seed -phase 2 -net 2 -addr 2.47 -zone "Basilisknet"
  376.  
  377.          (the "47" is an arbitrary node number). This will set up a zone
  378.          "Ethernet" (net 1) for the Ethernet and a zone "Basilisknet" (net 2)
  379.          for the internal network connection of the ethertap interface.
  380.          MacOS should automatically recognize the nets and zones upon startup.
  381.          If you are in an existing AppleTalk network, you should contact
  382.          your network administrator about the nets and zones you can use
  383.          (instead of the ones given in the example above).
  384.  
  385.   FreeBSD:
  386.     The "ethertap" method described above also works under FreeBSD, but since
  387.     no-one has found the time to write a section for this manual, you're on
  388.     your own here...
  389.  
  390.   AmigaOS:
  391.     You have to specify the name of the SANA-II Ethernet device and the device
  392.     unit as "<device name>/<unit>" (e.g. "ariadne.device/0"). If the given
  393.     device is not a SANA-II device, Basilisk II will crash. If the device is
  394.     not an Ethernet device, Basilisk II will display a warning message and
  395.     disable Ethernet networking.
  396.  
  397. rom <ROM file path>
  398.  
  399.   This item specifies the file name of the Mac ROM file to be used by
  400.   Basilisk II. If no "rom" line is given, the ROM file has to be named
  401.   "ROM" and put in the same directory as the Basilisk II executable.
  402.  
  403. bootdrive <drive number>
  404.  
  405.   Specify MacOS drive number of boot volume. "0" (the default) means
  406.   "boot from first bootable volume".
  407.  
  408. bootdriver <driver number>
  409.  
  410.   Specify MacOS driver number of boot volume. "0" (the default) means
  411.   "boot from first bootable volume". Use "-62" to boot from CD-ROM.
  412.  
  413. ramsize <bytes>
  414.  
  415.   Allocate "bytes" bytes of RAM for MacOS system and application memory.
  416.   The value given will be rounded down to the nearest multiple of 1MB.
  417.   If you are using a Mac Classic ROM, the maximum available value is 4MB
  418.   and higher values will be ignored. The default is 8MB.
  419.  
  420. frameskip <frames to skip>
  421.  
  422.   For refreshed graphics modes (usually window modes), this specifies
  423.   how many frames to skip after drawing one frame. Higher values make
  424.   the video display more responsive but require more processing power.
  425.   The default is "8". Under Unix/X11, a value of "0" selects a "dynamic"
  426.   update mode that cuts the display into rectangles and updates each
  427.   rectangle individually, depending on display changes.
  428.  
  429. modelid <MacOS model ID>
  430.  
  431.   Specifies the Model ID that Basilisk II should report to MacOS.
  432.   The default is "5" which corresponds to a Mac IIci. If you want to
  433.   run MacOS 8, you have to set this to "14" (Quadra 900). Other values
  434.   are not officially supported and may result in crashes. MacOS versions
  435.   earlier than 7.5 may only run with the Model ID set to "5". If you are
  436.   using a Mac Classic ROM, the model is always "Mac Classic" and this
  437.   setting is ignored.
  438.  
  439. nosound <"true" or "false">
  440.  
  441.   Set this to "true" to disable all sound output. This is useful if the
  442.   sound takes too much CPU time on your machine or to get rid of warning
  443.   messages if Basilisk II can't use your audio hardware.
  444.  
  445. nocdrom <"true" or "false">
  446.  
  447.   Set this to "true" to disable Basilisk's built-in CD-ROM driver.
  448.   The only reason to do this is if you want to use a third-party CD-ROM
  449.   driver that uses the SCSI Manager. The default is "false".
  450.  
  451. nogui <"true" or "false">
  452.  
  453.   Set this to "true" to disable the GUI preferences editor and GUI
  454.   error alerts. All errors will then be reported to stdout. The default
  455.   is "false".
  456.  
  457. For additional information, consult the source.
  458.  
  459.  
  460. System-specific configuration
  461. -----------------------------
  462.  
  463. Unix:
  464.  
  465.   keycodes <"true" or "false">
  466.   keycodefile <keycodes file path>
  467.  
  468.     By default, the X11 event handler in Basilisk II uses KeySyms to
  469.     translate keyboard event to Mac keycodes. While this method is very
  470.     compatible and ought to work with all X servers, it only works well
  471.     if your keyboard has a US layout. If you set "keycodes" to "true",
  472.     Basilisk II will use raw keycodes instead of KeySyms. The keycode
  473.     depends only on the physical location of a key on the keyboard and
  474.     not on the selected keymap. Unfortunately it depends on the X server
  475.     being used and possibly also on the type of keyboard attached. So
  476.     Basilisk II needs a table to translate X keycodes to Mac keycodes.
  477.     This table is read by default from /usr/local/share/BasiliskII/keycodes
  478.     unless you specify a different file with the "keycodefile" item.
  479.     A sample keycode file is included with Basilisk II.
  480.  
  481.   fbdevicefile <fbdevices file path>
  482.  
  483.     This option specifies the file that contains frame buffer device
  484.     specifications for the fbdev-DGA video mode (when Basilisk II was
  485.     configured with --enable-fbdev-dga). The default location of the file
  486.     is /usr/local/share/BasiliskII/fbdevices. A sample file is included
  487.     with Basilisk II.
  488.  
  489.   mousewheelmode <mode>
  490.  
  491.     If you have a mouse with a wheel, this option specifies whether moving
  492.     the wheel will be reported to the MacOS as "Page up/down" (mode 0) or
  493.     "Cursor up/down" (mode 1) keys.
  494.  
  495.   mousewheellines <number of lines>
  496.  
  497.     If "mousewheelmode" is set to mode 1 (Cursor up/down), this option sets
  498.     the number of key events sent to MacOS for each wheel movement (the
  499.     number of lines to scroll).
  500.  
  501. AmigaOS:
  502.  
  503.   sound <sound output description>
  504.  
  505.     This item specifies what method to use for sound output. The only choice
  506.     is currently AHI, but you can specify the AHI mode ID to be used. The
  507.     "sound output description" looks like this:
  508.  
  509.       ahi/<hexadecimal mode ID>
  510.  
  511.   scsimemtype <type>
  512.  
  513.     This item controls the type of memory to use for SCSI buffers. Possible
  514.     values are:
  515.       0 Chip memory
  516.       1 24-bit DMA capable memory
  517.       2 Any memory
  518.  
  519.     Be warned that many SCSI host adapters will not work with the "Any memory"
  520.     setting. Basilisk II has no way of knowing which memory type is supported
  521.     by the host adapter and setting an unsupported type will result in data
  522.     corruption.
  523.  
  524. Windows:
  525.  
  526.   noscsi <"true" or "false">
  527.  
  528.     Completely disables SCSI Manager support when set to "true".
  529.     Note that currently all SCSI operations are executed synchronously,
  530.     even if Mac application has requested asynchronous operation. What this
  531.     means is that the control is not returned to the application until the
  532.     command is completely finished. Normally this is not an issue, but when a
  533.     CDR/CDRW is closed or erased the burner program typically wants to wait in
  534.     some progress dialog The result may be that the application reports a
  535.     time-out error, but the operation completes all right anyway.
  536.  
  537.   nofloppyboot <"true" or "false">
  538.  
  539.     Set this to "true" to disable booting from a floppy.
  540.  
  541.   replacescsi <"Vendor1"> <"Model1"> <"Vendor2"> <"Model2">
  542.  
  543.     This command tricks the Mac to believe that you have a SCSI device Model2
  544.     from vendor Vendor2, although your real hardware is Model1 from Vendor1.
  545.     This is very useful since many devices have almost identical ATAPI and SCSI
  546.     versions of their hardware, and MacOS applications usually support the SCSI
  547.     version only. The example below is typical:
  548.   
  549.       replacescsi "HP" "CD-Writer+ 7100" "PHILIPS" "CDD3600"
  550.   
  551.     Note the use of quotes.
  552.  
  553.   rightmouse <0/1>
  554.  
  555.     Defines what the right mouse button is used for. The default values of 0
  556.     means that it is used to move windowed mode BasiliskII screen.
  557.     Value 1 sends a combination Control and mouse click to the MacOS.
  558.     This may be useful under OS versions 8 and above.
  559.  
  560.   keyboardfile <path>
  561.  
  562.     Defines the path of the customized keyboard code file.
  563.  
  564.   pollmedia <"true" or "false">
  565.  
  566.     If true (default), tries to automatically detect new media.
  567.     Applies to all "floppy", "cd" or "disk" removable media except
  568.     1.44 MB floppies. May cause modest slow down. If unchecked, 
  569.     use Ctrl-Shift-F11 to manually mount new media.
  570.     If you have auto-insert notification (AIN) enabled, you may turn this
  571.     option off. Note that some CD related software require AIN,
  572.     and some other need it to be turned off. Consult the documentation
  573.     of your CD software to learn which one is optimal for you.
  574.  
  575.   framesleepticks <milliseconds>    
  576.  
  577.     The amount of time between video frames.
  578.  
  579.   showfps <true/false>
  580.  
  581.     If true, the real frame rate is displayed.
  582.  
  583.   stickymenu <true/false>
  584.  
  585.     If true, the main menu bar is kept open even after the mouse button is released,
  586.     under all OS versions (OS 8 has this feature already). There are extensions to do 
  587.     the same thing, but it's faster to handle this in native code.
  588.     Default is "true".
  589.  
  590.   ntdx5hack <"true" or "false">
  591.  
  592.     You may need this on NT if your display adapter driver has a bug in DirectX
  593.     palette support. Black and white are reversed. It fixes the palette issue
  594.     by using GDI palette instead of D3D palette. Default is false.
  595.  
  596.  
  597. Usage
  598. -----
  599.  
  600. Quitting:
  601.   The right way to quit Basilisk II is to select the "Shut Down" menu item
  602.   from the Finder's "Special" menu. You should not kill it from the shell
  603.   unless it hangs. Under Unix, pressing "Esc" while holding the Ctrl key will
  604.   also quit Basilisk II (in case you are using it in DGA mode and it crashed).
  605.   Under Windows, try Alt-F4 (or Control-Alt-Del to log off and back on again
  606.   if it crashes really badly).
  607.  
  608. Suspending:
  609.   The Unix version of Basilisk II can be suspended while running in DGA mode
  610.   by pressing "Tab" while holding the Ctrl key. Pressing "Space" in the
  611.   "suspended" window will resume the emulation. Under BeOS, switching to
  612.   a different Workspace when BasiliskII is in full-screen mode will also
  613.   suspend the emulation.
  614.  
  615. Keyboard:
  616.   On PC-style keyboards, "Alt" is the Mac "Command" key, while the "Windows"
  617.   key is the Mac "Option" key.
  618.  
  619. Floppy:
  620.   Basilisk II can only handle 1.44MB MFM floppies. Depending on your platform,
  621.   flopyy disk changes might not be detected automatically. Under Linux, press
  622.   Ctrl-F1 to mount a floppy. Under BeOS, select the appropriate "Mount" menu
  623.   item or press Ctrl-F1 to mount a floppy. Under Windows, press Ctrl-Shift-F11.
  624.  
  625. HFS partitions:
  626.   Having HFS partitions mounted for read-write access under Basilisk II while
  627.   they are also mounted on the host OS will most likely result in volume
  628.   corruption and data losses. Unmount your HFS volumes before starting
  629.   Basilisk II.
  630.  
  631. ZIP drives:
  632.   Iomega ZIP disks can be mounted either with the "disk" prefs item or (on
  633.   platforms that support the SCSI Manager emulation of Basilisk II) by
  634.   installing the IomegaWare on the Mac side. Do not use both ways
  635.   simultaneously!
  636.  
  637. Hardfiles:
  638.   In addition to plain images of HFS volumes, Basilisk II can also handle
  639.   some types of Mac "disk image" files, as long as they are uncompressed
  640.   and unencoded.
  641.  
  642. Mac Classic emulation:
  643.   Sound output and Ethernet are not supported if you are using a Mac Classic
  644.   ROM. Also, the video display is fixed to 512x342 in monochrome. The AmigaOS
  645.   and BeOS/PPC versions of Basilisk II cannot do Mac Classic emulation.
  646.  
  647. Sound output:
  648.   Sound output under Basilisk II requires Sound Manager 3.0 or later. This
  649.   is included starting with MacOS 7.5 and available as a system extension
  650.   for earlier MacOS versions. Sample rate, bit resolution and mono/stereo
  651.   can be selected in the Sound control panel (section "Sound Out").
  652.  
  653. Ethernet:
  654.   Basilisk II supports all Ethernet protocols. Running a protocol under
  655.   Basilisk II that already runs within the host operating system on the same
  656.   network card (e.g. running MacTCP under Basilisk II on a BeOS machine) may
  657.   or may not work (generally, it should work, but some specific things like
  658.   "ping" may not). If you have problems with FTP, try setting your FTP client
  659.   to passive mode.
  660.  
  661. LocalTalk:
  662.   LocalTalk is not supported by Basilisk II. There is no way of getting
  663.   LocalTalk to work with the serial drivers of Basilisk II. Any attempt to
  664.   activate LocalTalk will either result in a crash or revert to Ethernet.
  665.  
  666. Serial:
  667.   You can use the serial ports in Basilisk II to connect to the Internet
  668.   with a modem and "MacPPP".
  669.  
  670.  
  671. Technical Documentation
  672. -----------------------
  673.  
  674. Please see the included file "TECH" for a technical overview of the emulator.
  675.  
  676.  
  677. Acknowledgements
  678. ----------------
  679.  
  680. Contributions by (in alphabetical order):
  681.  - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
  682.  - Gwenole Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations and
  683.    fbdev video code
  684.  - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
  685.  - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
  686.    and networking
  687.  - Bill Huey <billh@mag.ucsd.edu>: 15/16 bit DGA and 15/16/32 bit X11
  688.    window support
  689.  - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
  690.  - Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support
  691.  - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
  692.  - David Lawrence <davidl@jlab.org>: incremental window refresh code
  693.  - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
  694.  - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
  695.  - and others...
  696.  
  697. Special thanks to:
  698.  - Bernd Schmidt for letting me use his UAE 68k emulation
  699.  - Daniel Bobbert who printed dozens of pages from the THINK Reference for
  700.    me years ago
  701.  - All ShapeShifter and SheepShaver users and beta testers
  702.  - Apple Computer Inc., who made writing a Macintosh emulator a child's play
  703.  
  704.  
  705. Bug reports
  706. -----------
  707.  
  708. You found a bug? Well, use the source, fix it and send the fix to
  709.   <Christian.Bauer@uni-mainz.de>
  710. for inclusion in the next release of Basilisk II.
  711.  
  712.  
  713. Author
  714. ------
  715.  
  716. You can contact me at <Christian.Bauer@uni-mainz.de>. Don't send bug
  717. reports, send fixes. Ports to other platforms are also very welcome.
  718. Please contact me before you intend to make major changes to the source.
  719. You might be working on something that I have already done or I may have
  720. different ideas about the Right Way to do it.
  721.  
  722. Questions about ROM files will not be answered. There is also no point in
  723. sending me questions etc. that are specific to the Windows port of
  724. Basilisk II. I don't have Windows and can't say anything about that.
  725. Ask Lauri Pesonen instead.
  726.  
  727.  
  728. Support
  729. -------
  730.  
  731. The official Basilisk II home page is at
  732.   http://www.uni-mainz.de/~bauec002/B2Main.html
  733.  
  734. There is no user-level support for Basilisk II at the moment.
  735.  
  736.  
  737. History
  738. -------
  739.  
  740. Please consult the file "ChangeLog" for the release history.
  741.  
  742.  
  743. Christian Bauer
  744. <Christian.Bauer@uni-mainz.de>
  745.